Skip to main content
Feedback

Post Reset Agreements

The Post Reset Agreements operation deletes field-level source agreements for individual records. This operation is used to unblock updates when records are stuck due to prior ranking exceptions, removed sources, or stale agreement data.

By default, the operation resets all agreements for a record. You can optionally limit the scope of the reset to a specific source, a specific field, or a specific field and source combination.

Basic authentication

To perform this operation using Basic authentication, send an HTTP POST request to:

https://<base URL>/mdm/universes/{universeId}/records/{recordId}/resetAgreements

where base URL is the URL for your Hub cloud that hosts your repository.

JWT authentication

To perform this operation using JSON Web Token (JWT) authentication, send an HTTP POST request to:

https://<base URL>mdm/universes/{universeId}/records/{recordId}/resetAgreements?repositoryId=<repository ID>

You must have the following MDM privileges:

  • Edit Records entitlement.

Path parameters

universeId Universe ID

recordId Record ID

Query parameters

repositoryId
Repository ID. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.

sourceId
Source ID. Case sensitive. Optional.
When specified, all agreements associated with the specified source for the given record are cleared.

You can obtain the source ID from the Sources page in the user interface.

fieldId
Field ID. Case sensitive. Optional.
When specified, all agreements associated with the specified field for the given record are cleared.

The field ID is the same identifier used in the Record Query Request API.

note
  • sourceId and fieldId are optional and can be used independently or together.
  • If both sourceId and fieldId are specified, only agreements associated with that field and source for the record are cleared.
  • If neither parameter is specified, all agreements for the record are cleared (default behavior).
  • These parameters are supported for both Basic and JWT authentication.

Request body

The request body is empty. Optional filtering is controlled through query parameters only.

Response

  • 200 (OK) Agreements reset.

  • 400 (Bad Request) System previously reset the request record. Sample response body:

    <error>
      <message>System previously reset the requested record ranking.</message>
    </error>

  • 400 (Bad Request) Request Universe does not have any ranked fields. Sample response body:

    <error>
      <message>Requested Universe does not have any ranked fields.
    </message>
    </error>

  • 400 (Bad Request) Source ranking is not enabled for the account. Sample response body:

    <error>
      <message>Source ranking is not enabled for the account.</message>
    </error>

  • 400 (Bad Request) The universeID parameter value contains only space characters. Sample response body:

    <error>
      <message>The given universe id is blank.</message>
    </error>

  • 401 (Invalid Credentials) JWT auth token is expired. Sample response body:

    <error>
      <message>Problem accessing /mdm/universes. Reason: Invalid credentials</message>
    </error>

  • 403 (You do not have permissions to access this resource) User does not have the required MDM privilege to perform the action. Applicable to JWT auth only. Sample response body:

    <error>
      <message>You do not have permissions to access this resource.</message>
    </error>
On this Page